Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document common cargo commands #2293

Merged
merged 2 commits into from
Mar 15, 2020
Merged

Conversation

Darksonn
Copy link
Contributor

@Darksonn Darksonn commented Mar 3, 2020

Currently you have to look inside the ci directory to find the commands, which does not lend itself very well to discoverability for new users. I personally found it difficult to find some of these, and I'm not the only one.

You can view the rendered markdown here.

@Darksonn Darksonn added the T-docs Topic: documentation label Mar 3, 2020
@Darksonn Darksonn self-assigned this Mar 3, 2020
@dekellum
Copy link
Contributor

dekellum commented Mar 3, 2020

Should there also be a suggestion for running loom?

@Darksonn
Copy link
Contributor Author

Darksonn commented Mar 3, 2020

Sure, what is the command?

@dekellum
Copy link
Contributor

dekellum commented Mar 3, 2020

That's the the thing, I can never remember it! (I'll try and dig it up...)

@dekellum
Copy link
Contributor

dekellum commented Mar 3, 2020

As my timing wasn't great, this could always be added as a followup if it is at all questionable! Draft verbiage, change as desired:

Also run the loom tests the way they are run in CI:

cd tokio # tokio crate in workspace
LOOM_MAX_PREEMPTIONS=1 RUSTFLAGS="--cfg loom" \
    cargo test --lib --release --features full -- --test-threads=1 --nocapture

Note this will first compile a release build, but in combination with LOOM_MAX_PREEMPTIONS=1 allows the loom tests to complete in a reasonable amount of time.

@Darksonn
Copy link
Contributor Author

Can we merge this?

@LucioFranco
Copy link
Member

LucioFranco commented Mar 13, 2020

@Darksonn you got three approvals :) feel free to merge!

@Darksonn Darksonn merged commit fce6845 into tokio-rs:master Mar 15, 2020
@Darksonn Darksonn deleted the document-ci-commands branch March 15, 2020 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-docs Topic: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants